@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.TYPE, AnnotationTarget.TYPE_PARAMETER])

annotation class MapboxStyleComposable

Marks a composable function as being expected to be used inside another composable function that is also marked or inferred to be marked as a MapboxStyleComposable.

PointListValue

data class PointListValue(val value: Value)

Defines a primitive that can accommodate a list of com.mapbox.geojson.Points.

SlotsContent

@Stable

data class SlotsContent

Class that holds MapboxMapComposable content per each slot.

StringListValue

@Immutable

data class StringListValue(val value: Value)

Defines a list of String primitive that can accommodate a list of String.

StringValue

@Immutable

data class StringValue(val value: Value)

Defines a String primitive that can accommodate a String. See String.

StyleImage

@Immutable

data class StyleImage(val imageId: String, val image: Image, val scale: Float? = null, val sdf: Boolean = false, val stretchX: List<ImageStretches> = listOf(), val stretchY: List<ImageStretches> = listOf(), val content: ImageContent? = null)

Style image to used with runtime styling.

StyleImportsConfig

@Stable

data class StyleImportsConfig

Class that holds ImportConfigs per each Import ID.

StyleState

@Stable

class StyleState

The state holder for the Style.

Transition

data class Transition

Defines the timing for the interpolation between a transitionable style layer property's previous value and new value.

Functions

GenericStyle

@Composable

fun GenericStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, slotsContent: SlotsContent = remember { SlotsContent() }, layerPositionedContent: LayerPositionedContent = remember { LayerPositionedContent() }, styleState: StyleState = rememberStyleState())

@Composable

fun ~~GenericStyle~~(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, slotsContent: SlotsContent = remember { SlotsContent() }, layerPositionedContent: LayerPositionedContent = remember { LayerPositionedContent() }, styleImportsConfig: StyleImportsConfig = remember { StyleImportsConfig() }, projection: Projection = Projection.INITIAL, atmosphereState: AtmosphereState = remember { AtmosphereState() }, terrainState: TerrainState = TerrainState.INITIAL, lightsState: LightsState = LightsState.INITIAL, styleTransition: TransitionOptions = remember { transition { } })

Generic Style that you can insert MapboxMapComposable functions in any slot you defined as a plain string, or set any map import configs given as plain string and Value pairs.

importConfigs

fun importConfigs(init: ImportConfigs.() -> Unit): ImportConfigs

Type-safe builder for ImportConfigs.

layerPositionedContent

fun layerPositionedContent(init: LayerPositionedContent.() -> Unit): LayerPositionedContent

Type-safe builder for layer position based MapboxMapComposable content.

MapStyle

@Composable

fun MapStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, styleState: StyleState = rememberStyleState())

@Composable

fun ~~MapStyle~~(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, projection: Projection = Projection.INITIAL, atmosphereState: AtmosphereState = remember { AtmosphereState() }, terrainState: TerrainState = TerrainState.INITIAL, lightsState: LightsState = LightsState.INITIAL, styleTransition: TransitionOptions = remember { transition { } })

A simple composable function to set the style to the map without slots or import configs.

rememberStyleImage

@Composable

fun rememberStyleImage(imageId: String, imageBitmap: ImageBitmap, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with ImageBitmap.

@Composable

fun rememberStyleImage(imageId: String, @DrawableRes resourceId: Int, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with resourceId.

@Composable

fun rememberStyleImage(key: Any?, imageId: String, painter: Painter, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with painter and key.

rememberStyleState

@Composable

inline fun rememberStyleState(crossinline init: StyleState.() -> Unit = {}): StyleState

Create and remember a StyleState with init block.

slotsContent

fun slotsContent(init: SlotsContent.() -> Unit): SlotsContent

Type-safe builder for slot based MapboxMapComposable content.

styleImportsConfig

fun styleImportsConfig(init: StyleImportsConfig.() -> Unit): StyleImportsConfig

Type-safe builder for StyleImportsConfig.